26. Apendix J Configuration parameters¶
Table 76 is a list of configuration parameters. For more up-to-date information please refer to Doxygen files.
| Macro | Documented In | Description |
|---|---|---|
| dg_configUSE_LP_CLK | Low Power clock used ( |
|
| dg_configEXEC_MODE | 20.3 | Configuration of a project for cached or mirrored execution from FLASH. |
| dg_configCODE_LOCATION | 20.3 | Configuration of a project for execution from RAM. |
| dg_configEXT_CRYSTAL_FREQ | Frequency of the crystal connected to the XTAL Oscillator: 16MHz or 32MHz. | |
| dg_configIMAGE_FLASH_OFFSET | Offset of the image if not placed at the beginning of QSPI Flash. | |
| dg_configUSER_CAN_USE_TIMER1 | Timer 1 usage. When set to 0, Timer1 is reserved for the OS tick. | |
| dg_configMEM_RETENTION_MODE | Retention memory configuration. 5 bits field; each bit controls whether the relevant memory block will be retained (1) or not (0). | |
| dg_configSHUFFLING_MODE | Memory Shuffling mode. See SYS_CTRL_REG:REMAP_RAMS field. |
|
| dg_configUSE_WDOG | Watchdog Service.
|
|
| dg_configFLASH_POWER_DOWN | Table 29 | Puts QSPI Flash to “Power Down” for the duration of the sleep period. |
| dg_configPOWER_1V8_ACTIVE | The rail from which the Flash is powered, if a Flash is used.
When set to 1, the 1V8 rail is powered, when the system is in active state. |
|
| dg_configPOWER_1V8_SLEEP | When set to 1, the 1V8 is powered during sleep. | |
| dg_configPOWER_1V8P | When set to 1, the 1V8P rail is powered. | |
| dg_configBATTERY_TYPE | Table 31 | Defines the battery type that is used in the system. |
| dg_configBATTERY_CHARGE_VOLTAGE | Table 31 | Defines the charging voltage setting for the charger hardware. |
| dg_configBATTERY_TYPE_CUSTOM_ADC_VOLTAGE | Table 31 | In case of a custom battery, this parameter must be defined to provide the charging voltage level of the battery (in ADC measurement units). |
| dg_configBATTERY_LOW_LEVEL | Table 31 | If not zero, this is the lowest allowed limit of the battery voltage. |
| dg_configPRECHARGING_THRESHOLD | Table 31 | The threshold below which pre-charging starts |
| dg_configCHARGING_THRESHOLD | Table 31 | The threshold that, when met, pre-charging stops and charging starts. |
| dg_configBATTERY_CHARGE_CURRENT | Table 31 | This is the charging current setting for the charger hardware. |
| dg_configBATTERY_PRECHARGE_CURRENT | Table 31 | This is the pre-charging current setting for the charger hardware. |
| dg_configBATTERY_CHARGE_NTC | Table 31 | It controls whether the thermal protection will be enabled or not. |
| dg_configPRECHARGING_TIMEOUT | Table 31 | The maximum time that pre-charging will last. |
| dg_configUSE_SOC | When set to 1, State of Charge function is enabled. | |
| dg_configUSE_USB | When set to 1, the USB interface is used | |
| dg_configUSE_USB_CHARGER | Table 31 | It enables / disables the use of the Charger from the application.
|
| dg_configUSE_USB_ENUMERATION | Table 31 | It controls whether enumeration with the USB. |
| dg_configALLOW_CHARGING_NOT_ENUM | Table 31 | It controls whether the Charger will start charging using charge current up to 100mA until the enumeration completes. |
| dg_configUSE_NOT_ENUM_CHARGING_TIMEOUT | Table 31 | According to the USB Specification, there is a time limit that a device, which is connected to the USB bus but not enumerated, can draw power. This configuration setting controls whether the Charger will respect this time limit or not. |
| dg_configPRECHARGING_INITIAL_MEASURE_DELAY | Table 31 | This is the time to wait before doing the first voltage measurement after starting pre-charging. |
| dg_configCHARGING_CC_TIMEOUT | Table 31 | The maximum time that the charging hardware will stay in the CC phase. |
| dg_configCHARGING_CV_TIMEOUT | Table 31 | The maximum time that the charging hardware will stay in the CV phase. |
| dg_configUSB_CHARGER_POLLING_INTERVAL | Table 31 | While being attached to a USB cable and the battery has been charged, this is the interval that the VBAT is polled to decide whether a new charge cycle will be started. |
| dg_configBATTERY_CHARGE_GAP | Table 31 | This is the safety limit used to check for battery overcharging. |
| dg_configBATTERY_REPLENISH_GAP | Table 31 | This is the threshold below the maximum voltage level of the battery where charging will be restarted in order to recharge the battery. |
| dg_configUSE_ProDK | When set to 1, the ProDK is used (controls specific settings for this board). | |
| dg_configUSE_SW_CURSOR | Use SW cursor. | |
| dg_configCACHEABLE_QSPI_AREA_LEN | Set the size (in bytes) of the QSPI flash cacheable area. All reads from offset 0 up to (not including) offset dg_configCACHEABLE_QSPI_AREA_LEN will be cached. In addition, any writes to this area will trigger cache flushing, to avoid any cache incoherence. The size must be 64KB-aligned, due to the granularity of
|
|
| dg_configFLASH_ADAPTER | When enabled the FLASH adapter is included in the compilation of the SDK.
|
|
| dg_configNVMS_ADAPTER | When enabled the NVMS (Non Volatile Memory Storage) adapter is included in the compilation of the SDK.
|
|
| dg_configNVMS_VES | 16.4.2 | Must be defined in order to use VES (Virtual EEPROM). |
| dg_configNVPARAM_ADAPTER | When enabled the NPARAM (Analog to Digital Converter) adapter is included in the compilation of the SDK.
|
|
| dg_configGPADC_ADAPTER | When enabled the GPADC (Non Volatile Parameters) adapter is included in the compilation of the SDK.
|
|
| dg_configBLE_PERIPHERAL | Table 50 | Set to 0 if the application is not using BLE-peripheral related code. |
| dg_configBLE_CENTRAL | Table 50 | Set to 0 if the application is not using BLE- central related code. |
| dg_configBLE_OBSERVER | Table 50 | Set to 0 if the application is not using BLE-observer related code. |
| dg_configBLE_BROADCASTER | Table 50 | Set to 0 if the application is not using BLE-broadcaster related code. |
| dg_configBLE_GATT_CLIENT | Table 50 | Set to 0 if the application is not using GATT client related code. |
| dg_configBLE_GATT_SERVER | Table 50 | Set to 0 if the application is not using GATT client related code. |
| dg_configBLE_L2CAP_COC | Table 50 | Set to 0 if the application is not using L2CAP connection oriented channels related code. |
| dg_configBLE_EVENT_COUNTER_ENABLE | Enable Event Counters in BLE ISR. If the application has not defined dg_configBLE_EVENT_COUNTER_ENABLE in its custom_config file, this is defined to the default value of 0 to disable the Event Counters in BLE stack ISR. |
|
| dg_configBLE_ADV_STOP_DELAY_ENABLE | Enable ADV_UNDERRUN workaround. If the application has not defined dg_configBLE_ADV_STOP_DELAY_ENABLE in its custom_config file, this is defined to the default value of 0 to disable the ADV_UNDERRUN workaround in the BLE adapter. |
|
| dg_configBLE_SKIP_LATENCY_API | Enable Secure Connections. If the application has not defined |
|
| dg_configBLE_CONN_EVENT_LENGTH_MIN | Minimum Connection Event Length. Minimum length for Connection Event in steps of 0.625ms. This is used in outgoing connection requests, connection parameter requests and connection updates. | |
| dg_configBLE_CONN_EVENT_LENGTH_MAX | Maximum Connection Event Length. Maximum length for Connection Event in steps of 0.625ms. This is used in outgoing connection requests, connection parameter requests and connection updates. | |
| dg_configBLE_DATA_LENGTH_RX_MAX | Maximum Receive Data Channel PDU Payload Length. If the application has not defined dg_configBLE_DATA_LENGTH_RX_MAX in its custom_config file, this is defined to the maximum value allowed by Bluetooth Core v_4.2, which is 251 octets. |
|
| dg_configBLE_DATA_LENGTH_TX_MAX | Maximum Transmit Data Channel PDU Payload Length. If the application has not defined dg_configBLE_DATA_LENGTH_TX_MAX in its custom_config file, this is defined to the maximum value allowed by Bluetooth Core v_4.2, which is 251 octets. |
|
| dg_configBLE_DUPLICATE_FILTER_MAX | Duplicate Filtering List Maximum size. This defines the size of the list used for duplicate filtering. When the duplicate filtering list is full, additional advertising reports or scan responses will be dropped. | |
| dg_configBLE_PAIR_INIT_KEY_DIST | Table 17 | Security keys to be distributed by the pairing initiator. This defines which security keys will be requested to be distributed by the pairing initiator during a pairing feature exchange procedure. |
| dg_configBLE_PAIR_RESP_KEY_DIST | Table 17 | Security keys to be distributed by the pairing responder. This defines which security keys will be requested to be distributed by the pairing responder during a pairing feature exchange procedure. |
| dg_configBLE_SECURE_CONNECTIONS | Table 17 | Enable Secure Connections. If the application has not defined dg_configBLE_SECURE_CONNECTIONS in its custom configuration file, this is defined by default to 1 to enable LE Secure Connections. |
| dg_configTRACK_OS_HEAP | 17.2.3 | Activation of OS Heap tracking. |
| dg_configUSE_DGTL | Enable DGTL interface. When this macro is enabled, the DGTL framework is available for use. The framework must furthermore be initialized in the application using dgtl_init(). Additionally, the UART adapter must be initialized accordingly. Please see sdk/middleware/dgtl/include/ for further DGTL configuration (in dgtl_config.h) and API. |
|
| dg_configI2C_ADAPTER | When enabled the I2C (Inter-Integrated Circuit) adapter is included in the compilation of the SDK.
|
|
| dg_configUSE_HW_I2C | When enabled the Inter-Integrated Circuit low level driver is included in the compilation of the SDK.
|
|
| dg_configSPI_ADAPTER | When enabled the SPI (Serial Peripheral Interface) adapter is included in the compilation of the SDK.
|
|
| dg_configUSE_HW_SPI | When enabled the Serial Peripheral Interface low level driver is included in the compilation of the SDK.
|
|
| dg_configUART_ADAPTER | 16.3.1 | Must be defined and set to 1, in a project, in order to enable the UART adapter |
| dg_configUSE_HW_UART | 16.3.1 | Must be defined and set to 1, in a project, in order to enable the UART adapter |
| dg_configTESTMODE_MEASURE_SLEEP_CURRENT | When set to 1, the system will go to sleep and never exit allowing for the sleep current to be measured. | |
| dg_configTEMPSENS_ADAPTER | When enabled the TEMPSENS (Temperature Sensor) adapter is included in the compilation of the SDK.
|
|
| dg_configUSE_HW_IRGEN | When enabled the Infra-Red Generator low level driver is included in the compilation of the SDK.
|
|
| dg_configUSE_HW_QUAD | When enabled the Quadrature decoder low level driver is included in the compilation of the SDK.
|
|
| dg_configRF_ADAPTER | When enabled the Radio adapter is included in the compilation of the SDK.
|
|
| dg_configUSE_HW_RF | When enabled the Radio module low level driver is included in the compilation of the SDK.
|
|
| dg_configUSE_HW_TIMER0 | When enabled the Timer 0 low level driver is included in the compilation of the SDK.
|
|
| dg_configUSE_HW_TIMER1 | When enabled the Timer 1 low level driver is included in the compilation of the SDK.
|
|
| dg_configUSE_HW_TIMER2 | When enabled the Timer 2 low level driver is included in the compilation of the SDK.
|
|
| dg_configPM_MAX_ADAPTERS_CNT | Maximum adapters count. Should be equal to the number of Adapters used by the Application. It can be larger (up to 254) than needed, at the expense of increased Retention Memory requirements. It cannot be 0. | |
| dg_configUSE_CLI | Enable Command Line Interface module. | |
| dg_configUSE_CONSOLE | Enable serial console module. | |
| dg_configUSE_CLI_STUBS | Enable Command Line Interface stubbed API. | |
| dg_configUSE_CONSOLE_STUBS | Enable serial console stubbed API. | |
| dg_configUSE_BOD | brief Brown-out Detection
|
|
| dg_configUSE_DCDC | When set to 1, the DCDC is used. | |
| dg_configDISABLE_BACKGROUND_FLASH_OPS | Disable background operations. When enabled, outstanding QSPI operations will take place during sleep time increasing the efficiency.
|
|
| dg_configCRYPTO_ADAPTER | The adapter for the cryptographic engines (AES/HASH and ECC). | |
| dg_configUSE_HW_WKUP | When enabled the Wakeup Timer low level driver is included in the compilation of the SDK.
|